RDKEMW-16338: Create Agents for documentation in entservices repos - #33
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a “doc-guardian” automation that evaluates a target PR for documentation impact and, when needed, opens a tracking issue that triggers a custom Copilot agent to generate/update documentation and raise a follow-on docs PR.
Changes:
- Introduces a manually triggered GitHub Actions workflow to analyze PR file changes and create/dedupe a Doc-Guardian issue for Copilot.
- Adds a custom
doc-guardianagent definition with an operating procedure for detecting doc gaps, updating docs, and creating a docs PR.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
.github/workflows/doc-guardian.yml |
New workflow to evaluate PR changes for doc impact, create/dedupe a tracking issue, and assign it to the Copilot agent. |
.github/agents/doc-guardian.agent.md |
New custom agent instructions for generating/verifying documentation and opening a documentation PR. |
Comment on lines
+11
to
+14
| permissions: | ||
| contents: read | ||
| pull-requests: write | ||
| issues: write |
Comment on lines
+115
to
+120
| existing="$(gh issue list \ | ||
| --repo "$REPO" \ | ||
| --state open \ | ||
| --search "[Doc-Guardian] in:title PR #$PR_NUMBER" \ | ||
| --json number \ | ||
| --jq '.[0].number // empty')" |
Comment on lines
+123
to
+126
| git config --global user.email "copilot@github.com" | ||
| git config --global user.name "Copilot Agent" | ||
| git remote set-url origin "https://x-access-token:$TOKEN@github.com/${GITHUB_REPOSITORY}.git" | ||
| git push origin "$CURRENT_BRANCH" |
Reason for change: add workflow and agent to automatically update documentation Test Procedure: see ticket Risks: None Priority: P2 Signed-off-by: melhar098_comcast <Mahmoud_El-haron@comcast.com>
melhar098
force-pushed
the
topic/RDKEMW-16338-agent
branch
from
May 8, 2026 20:25
8dab55d to
c234d42
Compare
srikanth-vv
approved these changes
May 8, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Reason for change: add workflow and agent to automatically update documentation
Test Procedure: see ticket
Risks: None
Priority: P2